home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / PInterfaces / MixedMode.p < prev    next >
Text File  |  1996-05-01  |  11KB  |  342 lines
  1. {
  2.      File:        MixedMode.p
  3.  
  4.      Contains:    Mixed Mode Manager Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. }
  18. {$IFC UNDEFINED UsingIncludes}
  19. {$SETC UsingIncludes := 0}
  20. {$ENDC}
  21.  
  22. {$IFC NOT UsingIncludes}
  23.  UNIT MixedMode;
  24.  INTERFACE
  25. {$ENDC}
  26.  
  27. {$IFC UNDEFINED __MIXEDMODE__}
  28. {$SETC __MIXEDMODE__ := 1}
  29.  
  30. {$I+}
  31. {$SETC MixedModeIncludes := UsingIncludes}
  32. {$SETC UsingIncludes := 1}
  33.  
  34. {$IFC UNDEFINED __TYPES__}
  35. {$I Types.p}
  36. {$ENDC}
  37.  
  38. {$PUSH}
  39. {$ALIGN MAC68K}
  40. {$LibExport+}
  41.  
  42. {$IFC FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE }
  43. {  Mixed Mode constants  }
  44. {  Current Routine Descriptor Version  }
  45.  
  46. CONST
  47.     kRoutineDescriptorVersion    = 7;
  48.  
  49. {  MixedModeMagic Magic Cookie/Trap number  }
  50.     _MixedModeMagic                = $AAFE;
  51.  
  52. {  Calling Conventions  }
  53.  
  54. TYPE
  55.     CallingConventionType                = INTEGER;
  56.  
  57. CONST
  58.     kPascalStackBased            = 0;
  59.     kCStackBased                = 1;
  60.     kRegisterBased                = 2;
  61.     kD0DispatchedPascalStackBased = 8;
  62.     kD1DispatchedPascalStackBased = 12;
  63.     kD0DispatchedCStackBased    = 9;
  64.     kStackDispatchedPascalStackBased = 14;
  65.     kThinkCStackBased            = 5;
  66.  
  67. {  ISA Types  }
  68.  
  69. TYPE
  70.     ISAType                                = SInt8;
  71.  
  72. CONST
  73.     kM68kISA                    = 0;
  74.     kPowerPCISA                    = 1;
  75.  
  76. {  RTA Types  }
  77.  
  78. TYPE
  79.     RTAType                                = SInt8;
  80.  
  81. CONST
  82.     kOld68kRTA                    = $00;
  83.     kPowerPCRTA                    = $00;
  84.     kCFM68kRTA                    = $10;
  85.  
  86. {$IFC GENERATINGPOWERPC }
  87.     GetCurrentISA                = kPowerPCISA;
  88.     GetCurrentRTA                = kPowerPCRTA;
  89. {$ELSEC}
  90. {$IFC GENERATINGCFM }
  91.     GetCurrentISA                = kM68kISA;
  92.     GetCurrentRTA                = kCFM68kRTA;
  93. {$ELSEC}
  94.     GetCurrentISA                = kM68kISA;
  95.     GetCurrentRTA                = kOld68kRTA;
  96. {$ENDC}
  97. {$ENDC}
  98.     GetCurrentArchitecture        = GetCurrentISA + GetCurrentRTA;
  99. {  Constants for specifing 68k registers  }
  100.     kRegisterD0                    = 0;
  101.     kRegisterD1                    = 1;
  102.     kRegisterD2                    = 2;
  103.     kRegisterD3                    = 3;
  104.     kRegisterD4                    = 8;
  105.     kRegisterD5                    = 9;
  106.     kRegisterD6                    = 10;
  107.     kRegisterD7                    = 11;
  108.     kRegisterA0                    = 4;
  109.     kRegisterA1                    = 5;
  110.     kRegisterA2                    = 6;
  111.     kRegisterA3                    = 7;
  112.     kRegisterA4                    = 12;
  113.     kRegisterA5                    = 13;
  114.     kRegisterA6                    = 14;                            {  A7 is the same as the PowerPC SP  }
  115.     kCCRegisterCBit                = 16;
  116.     kCCRegisterVBit                = 17;
  117.     kCCRegisterZBit                = 18;
  118.     kCCRegisterNBit                = 19;
  119.     kCCRegisterXBit                = 20;
  120.  
  121.  
  122. TYPE
  123.     registerSelectorType                = INTEGER;
  124. {  SizeCodes we use everywhere  }
  125.  
  126. CONST
  127.     kNoByteCode                    = 0;
  128.     kOneByteCode                = 1;
  129.     kTwoByteCode                = 2;
  130.     kFourByteCode                = 3;
  131.  
  132. {  Mixed Mode Routine Records  }
  133.  
  134. TYPE
  135.     ProcInfoType                        = LONGINT;
  136. {  Routine Flag Bits  }
  137.     RoutineFlagsType                    = INTEGER;
  138.  
  139. CONST
  140.     kProcDescriptorIsAbsolute    = $00;
  141.     kProcDescriptorIsRelative    = $01;
  142.  
  143.     kFragmentIsPrepared            = $00;
  144.     kFragmentNeedsPreparing        = $02;
  145.  
  146.     kUseCurrentISA                = $00;
  147.     kUseNativeISA                = $04;
  148.  
  149.     kPassSelector                = $00;
  150.     kDontPassSelector            = $08;
  151.  
  152.     kRoutineIsNotDispatchedDefaultRoutine = $00;
  153.     kRoutineIsDispatchedDefaultRoutine = $10;
  154.  
  155. {$ENDC}
  156. {$IFC FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE }
  157.  
  158. CONST
  159.     kProcDescriptorIsProcPtr    = $00;
  160.     kProcDescriptorIsIndex        = $20;
  161.  
  162.  
  163. TYPE
  164.     RoutineRecordPtr = ^RoutineRecord;
  165.     RoutineRecord = RECORD
  166.         procInfo:                ProcInfoType;                            {  calling conventions  }
  167.         reserved1:                SInt8;                                    {  Must be 0  }
  168.         ISA:                    ISAType;                                {  Instruction Set Architecture  }
  169.         routineFlags:            RoutineFlagsType;                        {  Flags for each routine  }
  170.         procDescriptor:            ProcPtr;                                {  Where is the thing we're calling?  }
  171.         reserved2:                UInt32;                                    {  Must be 0  }
  172.         selector:                UInt32;                                    {  For dispatched routines, the selector  }
  173.     END;
  174.  
  175.     RoutineRecordHandle                    = ^RoutineRecordPtr;
  176. {  Mixed Mode Routine Descriptors  }
  177. {  Definitions of the Routine Descriptor Flag Bits  }
  178.     RDFlagsType                            = UInt8;
  179.  
  180. CONST
  181.     kSelectorsAreNotIndexable    = $00;
  182.     kSelectorsAreIndexable        = $01;
  183.  
  184. {  Routine Descriptor Structure  }
  185.  
  186. TYPE
  187.     RoutineDescriptorPtr = ^RoutineDescriptor;
  188.     RoutineDescriptor = PACKED RECORD
  189.         goMixedModeTrap:        UInt16;                                    {  Our A-Trap  }
  190.         version:                SInt8;                                    {  Current Routine Descriptor version  }
  191.         routineDescriptorFlags:    RDFlagsType;                            {  Routine Descriptor Flags  }
  192.         reserved1:                UInt32;                                    {  Unused, must be zero  }
  193.         reserved2:                UInt8;                                    {  Unused, must be zero  }
  194.         selectorInfo:            UInt8;                                    {  If a dispatched routine, calling convention, else 0  }
  195.         routineCount:            UInt16;                                    {  Number of routines in this RD  }
  196.         routineRecords:            ARRAY [0..0] OF RoutineRecord;            {  The individual routines  }
  197.     END;
  198.  
  199.     RoutineDescriptorHandle                = ^RoutineDescriptorPtr;
  200. {$ENDC}
  201. {$IFC FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE }
  202. {  Mixed Mode ProcInfos  }
  203.  
  204. CONST
  205.                                                                 {  Calling Convention Offsets  }
  206.     kCallingConventionWidth        = 4;
  207.     kCallingConventionPhase        = 0;
  208.     kCallingConventionMask        = $0F;                            {  Result Offsets  }
  209.     kResultSizeWidth            = 2;
  210.     kResultSizePhase            = 4;
  211.     kResultSizeMask                = $30;                            {  Parameter offsets & widths  }
  212.     kStackParameterWidth        = 2;
  213.     kStackParameterPhase        = 6;
  214.     kStackParameterMask            = $FFFFFFC0;                    {  Register Result Location offsets & widths  }
  215.     kRegisterResultLocationWidth = 5;
  216.     kRegisterResultLocationPhase = 6;                            {  Register Parameter offsets & widths  }
  217.     kRegisterParameterWidth        = 5;
  218.     kRegisterParameterPhase        = 11;
  219.     kRegisterParameterMask        = $7FFFF800;
  220.     kRegisterParameterSizePhase    = 0;
  221.     kRegisterParameterSizeWidth    = 2;
  222.     kRegisterParameterWhichPhase = 2;
  223.     kRegisterParameterWhichWidth = 3;                            {  Dispatched Stack Routine Selector offsets & widths  }
  224.     kDispatchedSelectorSizeWidth = 2;
  225.     kDispatchedSelectorSizePhase = 6;                            {  Dispatched Stack Routine Parameter offsets  }
  226.     kDispatchedParameterPhase    = 8;                            {  Special Case offsets & widths  }
  227.     kSpecialCaseSelectorWidth    = 6;
  228.     kSpecialCaseSelectorPhase    = 4;
  229.     kSpecialCaseSelectorMask    = $03F0;
  230.  
  231. {$ENDC}
  232. {$IFC FOR_SYSTEM7_AND_SYSTEM8_COOPERATIVE }
  233.  
  234. CONST
  235.     kSpecialCase                = $000F;                        {  (CallingConventionType)  }
  236.  
  237.                                                                 {  all of the special cases enumerated.  The selector field is 6 bits wide  }
  238.     kSpecialCaseHighHook        = 0;
  239.     kSpecialCaseCaretHook        = 0;                            {  same as kSpecialCaseHighHook  }
  240.     kSpecialCaseEOLHook            = 1;
  241.     kSpecialCaseWidthHook        = 2;
  242.     kSpecialCaseTextWidthHook    = 2;                            {  same as kSpecialCaseWidthHook  }
  243.     kSpecialCaseNWidthHook        = 3;
  244.     kSpecialCaseDrawHook        = 4;
  245.     kSpecialCaseHitTestHook        = 5;
  246.     kSpecialCaseTEFindWord        = 6;
  247.     kSpecialCaseProtocolHandler    = 7;
  248.     kSpecialCaseSocketListener    = 8;
  249.     kSpecialCaseTERecalc        = 9;
  250.     kSpecialCaseTEDoText        = 10;
  251.     kSpecialCaseGNEFilterProc    = 11;
  252.     kSpecialCaseMBarHook        = 12;
  253.  
  254. {
  255.     NOTES ON USING ROUTINE DESCRIPTOR FUNCTIONS
  256.     
  257.     When calling these routine from classic 68k code there are two possible intentions.
  258.  
  259.     The first is source compatibility with code ported to CFM (either PowerPC or 68k CFM). When
  260.     the code is compiled for CFM the functions create routine descriptors that can be used by
  261.     the mixed mode manager operating on that machine. When the code is compiled for classic 68k
  262.     these functions do nothing so that the code will run on Macintoshes that do not have a
  263.     mixed mode manager. The dual nature of these functions is achieved by turning the CFM calls
  264.     into "no-op" macros for classic 68k: You can put "NewRoutineDescriptor" in your source,
  265.     compile it for any runtime or instruction set architecture, and it will run correctly on the
  266.     intended runtime/instruction platform. All without source changes and/or conditional source.
  267.     
  268.     The other intention is for code that "knows" that it is executing as classic 68k runtime
  269.     and is specifically trying to call code of another architecture using mixed mode. Since the
  270.     routines were designed with classic <-> CFM source compatibility in mind this second case
  271.     is treated special. For classic 68k code to create routines descriptors for use by mixed mode
  272.     it must call the "Trap" versions of the routines (NewRoutineDescriptorTrap). These versions
  273.     are only available to classic 68k callers: rigging the interfaces to allow calling them
  274.     from CFM code will result in runtime failure because no shared library implements or exports
  275.     the functions.
  276.     
  277.  
  278.     This almost appears seamless until you consider "fat" routine descriptors and the advent of
  279.     CFM-68K. What does "fat" mean? CFM-68K is not emulated on PowerPC and PowerPC is not emulated
  280.     on CFM-68K. It makes no sense to create a routine descriptor having both a CFM-68K routine
  281.     and a PowerPC native routine pointer. Therefore "fat" is defined to be a mix of classic and
  282.     CFM for the hardware's native instruction set: on PowerPC fat is classic and PowerPC native,
  283.     on a 68k machine with CFM-68K installed fat is classic and CFM-68K.
  284.     
  285.     By definition fat routine descriptors are only constructed by code that is aware of the 
  286.     architecture it is executing as and that another architecture exists. Source compatibility
  287.     between code intented as pure classic and pure CFM is not an issue and so NewFatRoutineDescriptor
  288.     is not available when building pure classic code.
  289.     
  290.     NewFatRoutineDescriptorTrap is available to classic code on both PowerPC and CFM-68K. The
  291.     classic code can use the code fragment manager routine "FindSymbol" to obtain the address of 
  292.     a routine in a shared library and then construct a routine descriptor with both the CFM routine 
  293.     and classic    routine.
  294. }
  295. {$IFC GENERATINGCFM }
  296. FUNCTION NewRoutineDescriptor(theProc: ProcPtr; theProcInfo: ProcInfoType; theISA: ISAType): UniversalProcPtr;
  297. PROCEDURE DisposeRoutineDescriptor(theProcPtr: UniversalProcPtr);
  298. FUNCTION NewFatRoutineDescriptor(theM68kProc: ProcPtr; thePowerPCProc: ProcPtr; theProcInfo: ProcInfoType): UniversalProcPtr;
  299. {$ELSEC}
  300. FUNCTION NewRoutineDescriptorTrap(theProc: ProcPtr; theProcInfo: ProcInfoType; theISA: ISAType): UniversalProcPtr;
  301.     {$IFC NOT GENERATINGCFM}
  302.     INLINE $7000, $AA59;
  303.     {$ENDC}
  304. PROCEDURE DisposeRoutineDescriptorTrap(theProcPtr: UniversalProcPtr);
  305.     {$IFC NOT GENERATINGCFM}
  306.     INLINE $7001, $AA59;
  307.     {$ENDC}
  308. FUNCTION NewFatRoutineDescriptorTrap(theM68kProc: ProcPtr; thePowerPCProc: ProcPtr; theProcInfo: ProcInfoType): UniversalProcPtr;
  309.     {$IFC NOT GENERATINGCFM}
  310.     INLINE $7002, $AA59;
  311.     {$ENDC}
  312. FUNCTION NewRoutineDescriptor(theProc: ProcPtr; theProcInfo: ProcInfoType; theISA: ISAType): UniversalProcPtr;
  313.     {$IFC NOT GENERATINGCFM}
  314.     INLINE $5C4F, $2E9F;
  315.     {$ENDC}
  316. PROCEDURE DisposeRoutineDescriptor(theProcPtr: UniversalProcPtr);
  317.     {$IFC NOT GENERATINGCFM}
  318.     INLINE $584F;
  319.     {$ENDC}
  320. {  Note that the call to NewFatRoutineDescriptor is undefined when GENERATINGCFM is false.  }
  321. {$ENDC}
  322. {$IFC GENERATINGCFM }
  323. {
  324.  CallUniversalProc is only implemented in shared libraries on 68k and PowerPC, it is now
  325.  conditionalize with GENERATINGCFM.  This will catch accidental calls from classic 68K code
  326.  that previously only showed up as linker errors.
  327. }
  328. FUNCTION CallUniversalProc(theProcPtr: UniversalProcPtr; procInfo: ProcInfoType; ...): LONGINT; C;
  329. FUNCTION CallOSTrapUniversalProc(theProcPtr: UniversalProcPtr; procInfo: ProcInfoType; ...): LONGINT; C;
  330. {$ENDC}
  331. {$ENDC}
  332. {$ALIGN RESET}
  333. {$POP}
  334.  
  335. {$SETC UsingIncludes := MixedModeIncludes}
  336.  
  337. {$ENDC} {__MIXEDMODE__}
  338.  
  339. {$IFC NOT UsingIncludes}
  340.  END.
  341. {$ENDC}
  342.